@ts-graphviz/ast

What is @ts-graphviz/ast?

@ts-graphviz/ast is an npm package that provides an Abstract Syntax Tree (AST) for Graphviz's DOT language. It allows you to parse, manipulate, and generate DOT files programmatically using TypeScript.

What are @ts-graphviz/ast's main functionalities?

Parsing DOT Files

This feature allows you to parse a DOT string into an AST. The code sample demonstrates how to parse a simple DOT string and output the resulting AST.

const { parse } = require('@ts-graphviz/ast');
const dot = 'digraph G { a -> b; }';
const ast = parse(dot);
console.log(JSON.stringify(ast, null, 2));

Generating DOT Files

This feature allows you to generate a DOT string from an AST. The code sample demonstrates how to create a simple AST and convert it back to a DOT string.

const { print } = require('@ts-graphviz/ast');
const ast = {
  type: 'Graph',
  id: 'G',
  body: [
    { type: 'EdgeStatement', edge_list: [{ id: 'a' }, { id: 'b' }] }
  ]
};
const dot = print(ast);
console.log(dot);

Manipulating AST

This feature allows you to manipulate the AST before converting it back to a DOT string. The code sample demonstrates how to add a new edge to the graph.

const { parse, print } = require('@ts-graphviz/ast');
let dot = 'digraph G { a -> b; }';
let ast = parse(dot);
ast.body.push({ type: 'EdgeStatement', edge_list: [{ id: 'b' }, { id: 'c' }] });
dot = print(ast);
console.log(dot);

Other packages similar to @ts-graphviz/ast

graphlib

Graphlib is a JavaScript library for creating and manipulating directed graphs. It provides a more general-purpose graph manipulation API compared to @ts-graphviz/ast, which is specifically focused on the DOT language.

viz.js

Viz.js is a library that allows you to render DOT files using Graphviz in the browser. While @ts-graphviz/ast focuses on parsing and generating DOT files, Viz.js is more about rendering them.

d3-graphviz

d3-graphviz is a library that integrates Graphviz with D3.js for rendering graphs in the browser. It provides higher-level visualization capabilities compared to the AST manipulation provided by @ts-graphviz/ast.

README

@ts-graphviz/ast

It is part of the ts-graphviz library, which is split into modular packages to improve maintainability, flexibility, and ease of use.

This package contains the module for processing the DOT language at the Abstract Syntax Tree (AST) level for the ts-graphviz library.

Features

• Parsing and generating DOT language ASTs
• Functions for manipulating and transforming ASTs
• Support for custom AST nodes and attributes

Usage

Import the necessary functions and classes from the @ts-graphviz/ast package:

import { parse, stringify } from '@ts-graphviz/ast';

Use the imported items in your project to work with DOT language ASTs:

const dotString = 'digraph G { A -> B; }';
const ast = parse(dotString);

const outputDotString = stringify(ast);
console.log('Output DOT string:', outputDotString);

For more examples and usage details, please refer to the ts-graphviz documentation.

Contributing

Contributions to the ts-graphviz project are welcome.

Please refer to the main ts-graphviz repository for guidelines on how to contribute.

License

This package is released under the MIT License.